schm-pos-nccs-eapi
API Reference (Chinese Version)
schm-pos-nccs-eapi
接口描述: 客服工单信息接口
DEV地址(开发环境): https://schm-api-dev.shiseido.cn/schm-pos-nccs-eapi
UAT地址(测试环境): https://schm-api-test.shiseido.cn/schm-pos-nccs-eapi
PROD地址(生产环境): https://schm-api.shiseido.cn/schm-pos-nccs-eapi
1.身份认证
所有请求头必须包含以下键值参数作为身份验证信息。您需要向管理员申请这些信息。
client_id: fa98****3452
client_secret: 108b****41f2
2.接口总览:
请求接口 | 描述 |
---|---|
/caseEntry | 客服工单信息接口 |
完整调用地址为对应环境地址+接口地址,例如:
https://schm-api-test.shiseido.cn/schm-pos-nccs-eapi/caseEntry
3.接口调用说明
3.1 客服工单信息接口
请求接口: /caseEntry
接口描述: 客服工单信息接口
请求类型: HTTP POST
3.2 参数说明
字段描述 | 字段名称 | 类型 | 长度 | 必填 | 备注 |
---|---|---|---|---|---|
品牌编号 | OwnerId | String | 4 | 是 | 工单对应店铺所属品牌 |
POS 客服申请单号 | TicketNo | String | 64 | 是 | 全品牌唯一 Key(非客服系统的工单号) |
受理方法 | AcceptMethodCode | String | 10 | 是 | 默认“返品” |
受理方法名称 | AcceptMethodName | String | 100 | ||
送达方代码 | StoreId | String | 10 | 是 | 店铺编号 |
送达方名称 | StoreName | String | 60 | 店铺名称 | |
案件受理者 | EmployeeId | String | 10 | 是 | |
案件受理者名称 | EmployeeName | String | 20 | ||
受理人联系电话 | AcceptedPhone | String | 30 | 是 | |
所属部门 | DeptCode | String | 10 | 底层 AP 固定给值(EC、store) | |
受理日期 | AcceptDate | DateTime | |||
购买交易号 | BillNo | int | 是 | ||
购买 POS 机号 | PosId | int | 是 | ||
客户姓名 | CustomerName | String | 10 | 是 | |
年龄代码 | AgeCode | String | 10 | 是 | |
年龄名称 | AgeName | String | 100 | ||
性别代码 | GenderCode | String | 10 | 是 | |
性别名称 | GenderName | String | 100 | ||
手机号 | Mobile | String | 50 | 是 | |
会员 ID | MemberNo | String | 13 | ||
国籍代码 | NationalityCode | String | 10 | ||
国籍名称 | NationalityName | String | 100 | ||
地区代码(顾客所属省) | ProvinceCode | String | 10 | 是 | |
地区名称 | ProvinceName | String | 100 | ||
民族代码 | NationCode | String | 10 | ||
民族名称 | NationName | String | 100 | ||
地址 | Address | String | 500 | ||
案件类型代码 | TicketTypeCode | String | 10 | 是 | 默认“顾客案件” |
案件类型名称 | TicketTypeName | String | 100 | ||
信息源代码 | InfoSourceCode | String | 10 | 是 | 默认“客户” |
信息源名称 | InfoSourceName | String | 100 | ||
信息特征代码 | InfoFeatureCode | String | 10 | 默认“不满意” | |
信息特征名称 | InfoFeatureName | String | 100 | ||
对应结果代码 | ProcessResultCode | String | 10 | 是 | |
对应结果名称 | ProcessResultName | String | 100 | 两个选项“退货”、“换货” | |
商品列表 | GoodsList | Array | 是 | GoodsInfo 对象数组,但目前只有 1 个。 | |
反映信息 | SymptomClassList | Array | 是 | SymptomClass 对象数组 | |
咨询信息 | InquireContentData | InquireContent | 是 | InquireContent 对象 |
商品信息 GoodsInfo:
字段描述 | 字段名称 | 类型 | 长度 | 是否必填 | 备注 |
---|---|---|---|---|---|
商品编号 | GoodsCode | String | 8 | 是 | |
商品名称 | GoodsName | String | 100 | ||
生产记号 | ProductBatchNo | String | 50 | 是 | |
到期日期 | ExpiredDate | DateTime | |||
购入日期 | BuyDate | DateTime |
反映信息(过敏症状)SymptomClass:
字段描述 | 字段名称 | 类型 | 长度 | 必填 | 备注 |
---|---|---|---|---|---|
内容分类 1 名称 | SymptomClass1Name | String | 100 | ||
内容分类 2 代码 | SymptomClass2Code | String | 10 | 是 | |
内容分类 2 名称 | SymptomClass2Name | String | 100 | ||
内容分类 3 代码 | SymptomClass3Code | String | 10 | 是 | |
内容分类 3 名称 | SymptomClass3Name | String | 100 | ||
是否主要症状代码 | CardinalSymptomFlagCode | String | 10 | 是 | |
是否主要症状名称 | CardinalSymptomFlagName | String | 10 |
询问信息 InquireContent:
字段描述 | 字段名称 | 类型 | 长度 | 是否必填 | 备注 |
---|---|---|---|---|---|
症状发生日期 | SymptomDate | DateTime | 是 | ||
症状发生部位代码(1) | SymptomParts1Code | String | 10 | 是 | |
症状发生部位名称(1) | SymptomParts1Name | String | 100 | ||
症状发生部位代码(2) | SymptomParts2Code | String | 10 | ||
症状发生部位名称(2) | SymptomParts2Name | String | 100 | ||
症状发生部位代码(3) | SymptomParts3Code | String | 10 | ||
症状发生部位名称(3) | SymptomParts3Name | String | 100 | ||
其他损害代码 | OtherSymptomCode | String | 10 | 是 | |
其他损害名称 | OtherSymptomName | String | 100 | ||
皮损形态代码 | SkinSymptomCode | String | 10 | 是 | |
皮损形态名称 | SkinSymptomName | String | 100 | ||
皮损形态其他内容 | SkinSymptomOtherCont ent | String | 200 | ||
初步判断代码 | PreliminaryResultCode | String | 10 | 是 | |
初步判断名称 | PreliminaryResultName | String | 100 | ||
初步判断其他内容 | PreliminaryResultOtherC ontent | String | 200 | ||
是否第一次使用致敏产品代码 | FirstUsedCode | String | 10 | 是 | |
是否第一次使用致敏产品名称 | FirstUsedName | String | 100 | ||
开始使用时间 | BeginUsedDate | DateTime | 是 | ||
使用次数 | UsedCount | int | |||
使用频率(次/ 天) | UsedFrequency | int | |||
使用停止状况代码 | StopUsedCode | String | 10 | ||
使用停止状况名称 | StopUsedName | String | 100 | ||
使用中止日期 | StopUsedDate | DateTime | 是 | ||
恢复状态代码(症状转换期) | RecoveryStatusCode | String | 10 | 是 | |
恢复状态名称(症状转换期) | RecoveryStatusName | String | 100 | ||
恢复状态-不明描述 | RecoveryStatusUnknow nContent | String | 200 | ||
恢复日期 | RecoveryDate | DateTime | |||
接受医疗机关诊察代码 | MedicalDiagnosisCode | String | 10 | ||
接受医疗机关诊察代码名称 | MedicalDiagnosisName | String | 100 | ||
医疗机关诊察日期 | MedicalDiagnosisDate | DateTime | |||
有无诊断书代码 | DiagnosisReportCode | String | 10 | ||
有无诊断书名称 | DiagnosisReportName | String | 100 | ||
医疗诊断书 | DiagnosisReportList | Array | 医疗诊断书图片,上传 OSS 的文件 key | ||
接受诊断医疗机关名称 | MedicalInstitutionName | String | 100 | ||
过敏体质·过敏经验代码 | AllergyCode | String | 10 | ||
过敏体质·过敏经验名称 | AllergyName | String | 100 | ||
过敏体质过敏经验内容 | AllergyContent | String | 200 | ||
对应种类代码 | ConsultTypeCode | String | 10 | 是 | |
对应种类名称 | ConsultTypeName | String | 100 | ||
咨询时期代码 | InquireDateCode | String | 10 | 是 | |
咨询时期说明 | InquireDateName | String | 100 | ||
详细反映(背景) | InquireDetail | String | 不限 | 是 | |
过敏照片 | AllergyImageList | Array | 过敏照片信息,上传 OSS 的文件 key |
3.3 参数示例
{
"OwnerId": "10",
"TicketNo": "CS240528GS5Dk201",
"AcceptMethodCode": "5",
"AcceptMethodName": "返品",
"StoreId": "00300023",
"StoreName": "SHI 第一八佰伴",
"EmployeeId": "00007672",
"EmployeeName": "叶伊俐",
"AcceptedPhone": "13688996699",
"DeptCode": "store",
"AcceptDate": "2024-4-30",
"BillNo": "888888",
"PosId": "1",
"CustomerName": "陈女士",
"AgeCode": "03",
"AgeName": "20 岁~29 岁",
"GenderCode": "1",
"GenderName": "女性",
"Mobile": "18812345678",
"MemberNo": "M1000167038",
"NationalityCode": "49",
"NationalityName ": "中国",
"ProvinceCode": "3",
"ProvinceName": "上海",
"NationCode": "2",
"NationName": "汉族",
"Address": "上海市南京东路 88 号",
"TicketTypeCode": "1",
"TicketTypeName": "顾客案件",
"InfoSourceCode": "1",
"InfoSourceName": "客户",
"InfoFeatureCode": "3",
"InfoFeatureName": "不满意",
"ProcessResultCode": "1",
"ProcessResultName": "退货",
"GoodsList": [
{
"GoodsCode": "10042",
"GoodsName": "SWL 资生堂透白美肌亮润柔肤水(清爽型)",
"ProductBatchNo": "2023121866666",
"ExpiredDate": "2026-03-25",
"BuyDate": "2024-02-14"
}
],
"SymptomClassList": [
{
"SymptomClass1Code": "012",
"SymptomClass1Name": "身体异常",
"SymptomClass2Code": "111",
"SymptomClass2Name": "皮肤・毛发・眼部异常",
"SymptomClass3Code": "041",
"SymptomClass3Name": "发红",
"CardinalSymptomFlagCode": "1",
"CardinalSymptomFlagName": "是"
}
],
"InquireContentData": {
"SymptomDate": "2024-04-25",
"SymptomParts1Code": "003",
"SymptomParts1Name": "全脸",
"SymptomParts2Code": "011",
"SymptomParts2Name": "眉毛",
"SymptomParts3Code": "",
"SymptomParts3Name": "",
"OtherSymptomCode": "1",
"OtherSymptomName": "全身性",
"SkinSymptomCode": "1",
"SkinSymptomName": "红斑",
"SkinSymptomOtherContent": "",
"PreliminaryResultCode": "2",
"PreliminaryResultName": "化妆品光感性皮炎",
"PreliminaryResultOtherContent": "",
"FirstUsedCode": "1",
"FirstUsedName": "是",
"BeginUsedDate": "2024-4-23",
"UsedCount": "6",
"UsedFrequency": "2",
"StopUsedCode": "1",
"StopUsedName": "使用中止",
"StopUsedDate": "2024-4-26",
"RecoveryStatusCode": "2",
"RecoveryStatusName": "好转",
"RecoveryStatusUnknownContent": "",
"RecoveryDate": "2024-4-28",
"MedicalDiagnosisCode": "1",
"MedicalDiagnosisName": "接受诊察",
"MedicalDiagnosisDate": "2024-4-27",
"DiagnosisReportCode": "1",
"DiagnosisReportName": "有",
"DiagnosisReportList": [
"NCCS\\POS\\xxxx.png",
"NCCS\\POS\\xxxx.png",
"NCCS\\POS\\xxxx.png",
"NCCS\\POS\\xxxx.png"
],
"MedicalInstitutionName": "上海市第十人民医院",
"AllergyCode": "0",
"AllergyName": "无",
"AllergyContent": "",
"ConsultTypeCode": "1",
"ConsultTypeName": "身体对应-无面谈",
"InquireDateCode": "1",
"InquireDateName": "初次购买后",
"InquireDetail": "XX 年 X 月 X 日收到 XXX(地区)XXX(人)寄来的皮肤过敏报告书:顾客 XXX(小姐、女士、先生)于 XX 年 X 月 X 日在 XXXXX(店名)购买 XXXXXX(产品名、制造记号)。什么时候使用?什么时候出现过敏?过敏症状?反映日期?使用方法?有无与其他品牌混用?是否第一次使用我司产品?是否是过敏性体质(有无化妆品过敏史)?有无医院诊断书?诊断为什么?店头已做退(换:具体产品)货处理。(如没有诊断证明的)无医院开具的诊断证明, 经 XXX( 地方工作人员) 签字确认, 顾客脸部确有明显症状,给予退货处理。 ",
"AllergyImageList": [
"NCCS\\POS\\xxxx.png",
"NCCS\\POS\\xxxx.png",
"NCCS\\POS\\xxxx.png",
"NCCS\\POS\\xxxx.png"
]
}
}
3.4 返回值说明
字段描述 | 字段名称 | 类型 | 必填 | 备注 | |
---|---|---|---|---|---|
返回 Code | ErrorCode | String | 是 | "0" 表示成功 | |
错误消息 | Message | String | 全品牌唯一 Key | ||
客服系统工单号 | CSTicketNo | String |
3.5 返回值示例
{
"ErrorCode": "0",
"Message": "",
"CSTicketNo": "xxxxxxxxxx"
}